Account Information Services APIs

(0 reviews)

Account and Transaction Information Examples

This section provides examples of API invocation covering Account resource access to retrieve account information, balance and transaction information.

1. Multiple account information

This is the first API that an AISP invokes (after the account request is authorised) to get the unique identifier (AccountID) for each PSU consented account.

The following optional field(s) is/are not populated by BOI for this API:

Description
Account.SecondaryIdentification
Account.Name
OpeningDate
MaturityDate

GET request: accounts

GET /accounts HTTP/1.1

Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d

Accept: application/json

GET response: accounts

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
    "Data": {
        "Account": [
            {
                "AccountId": "87cb60fe-a16e-4189-a9da-949c187113ba",
                "Status": "Enabled",
                "StatusUpdateDateTime": "2019-01-01T06:06:06+00:00",
                "Currency": "EUR",
                "AccountType": "Personal",
                "AccountSubType": "Savings",
                "Nickname": "Mila Robins",
                "SwitchStatus": "UK.CASS.NotSwitched"
                "Account": [
                    {
                        "SchemeName": "UK.OBIE.IBAN",
                        "Identification": "IE40BOFI90123968920165"
                    }
                ],
                "Servicer": {
                    "SchemeName": "BICFI",
                    "Identification": "BOFIIE2DXXX"
                }
            },
            {
                "AccountId": "bcb4cf6b-c269-4d99-8662-2834dc4a7ada",
                "Status": "Enabled",
                "StatusUpdateDateTime": "2019-01-01T06:06:06+00:00",
                "Currency": "EUR",
                "AccountType": "Personal",
                "AccountSubType": "CurrentAccount",
                "Nickname": "Mila Robins",
                "SwitchStatus": "UK.CASS.NotSwitched"
                "Account": [
                    {
                        "SchemeName": "UK.OBIE.IBAN",
                        "Identification": "IE47BOFI90126312660908"
                    }
                ],
                "Servicer": {
                    "SchemeName": "BICFI",
                    "Identification": "BOFIIE2DXXX"
                }
            },
            {
                "AccountId": "26c28c3d-dd82-4ac8-bfd5-4ca543141135",
                "Status": "Enabled",
                "StatusUpdateDateTime": "2019-01-01T06:06:06+00:00",
                "Currency": "EUR",
                "AccountType": "Personal",
                "AccountSubType": "CurrentAccount",
                "Nickname": "Mila Robins",
                "SwitchStatus": "UK.CASS.NotSwitched"
                "Account": [
                    {
                        "SchemeName": "UK.OBIE.IBAN",
                        "Identification": "IE33BOFI90129856596415"
                    }
                ],
                "Servicer": {
                    "SchemeName": "BICFI",
                    "Identification": "BOFIIE2DXXX"
                }
            }
        ]
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/aisp/accounts"
    },
    "Meta": {
        "TotalPages": 1
    }
}

2. Single account information

This API allows an AISP to retrieve information of a single bank account identified by the unique AccountID.

The following optional field(s) is/are not populated by BOI for this API:

Description
Account.SecondaryIdentification
Account.Name
OpeningDate
MaturityDate

GET request: accounts

GET /accounts/87cb60fe-a16e-4189-a9da-949c187113ba HTTP/1.1

Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

GET response: accounts

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
    "Data": {
        "Account": [
            {
                "AccountId": "87cb60fe-a16e-4189-a9da-949c187113ba",
                "Status": "Enabled",
                "StatusUpdateDateTime": "2019-01-01T06:06:06+00:00",
                "Currency": "EUR",
                "AccountType": "Personal",
                "AccountSubType": "Savings",
                "Nickname": "Mila Robins",
                "SwitchStatus": "UK.CASS.NotSwitched"
                "Account": [
                    {
                        "SchemeName": "UK.OBIE.IBAN",
                        "Identification": "IE40BOFI90123968920165"
                    }
                ],
                "Servicer": {
                    "SchemeName": "BICFI",
                    "Identification": "BOFIIE2DXXX"
                }
            }
        ]
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/aisp/accounts/87cb60fe-a16e-4189-a9da-949c187113ba"
    },
    "Meta": {
        "TotalPages": 1
    }
}

3. Account Balance

This API allows an AISP to retrieve balance information of a single bank account identified by the unique AccountID.

GET request : Accounts Balances

GET /accounts/87cb60fe-a16e-4189-a9da-949c187113ba/balances HTTP/1.1

Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

GET response: Accounts Balances

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
    "Data": {
        "Balance": [
            {
                "AccountId": "87cb60fe-a16e-4189-a9da-949c187113ba",
                "CreditDebitIndicator": "Credit",
                "Type": "Expected",
                "DateTime": "2018-09-09T10:43:07+00:00",
                "Amount": {
                    "Amount": "367.00",
                    "Currency": "EUR"
                }
            }
        ]
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/aisp/accounts/87cb60fe-a16e-4189-a9da-949c187113ba/balances"
    },
    "Meta": {
        "TotalPages": 1
    }
}

4. Beneficiaries

This API allows an AISP to retrieve the list of trusted beneficiaries linked to a specific customer.

The following optional field(s) is/are not populated by BOI for this API:

CreditorAgent.Name
CreditorAgent.PostalAddress
CreditorAccount.SecondaryIdentification
SupplementaryData

GET request: Accounts Beneficiaries

GET /accounts/87cb60fe-a16e-4189-a9da-949c187113ba/beneficiaries HTTP/1.1

Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

GET response: Accounts Beneficiaries

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
    "Data": {
        "Beneficiary": [
            {
                "AccountId": "87cb60fe-a16e-4189-a9da-949c187113ba",
                "BeneficiaryId": "B00187861",
                "BeneficiaryType": "Ordinary",
                "Reference": "SSEAirtricity",
                "CreditorAgent": {
                    "SchemeName": "BICFI",
                    "Identification": "BOFIIE2DXXX"
                },
                "CreditorAccount": {
                    "SchemeName": "UK.OBIE.IBAN",
                    "Identification": "IE40BOFIXXXXXXXX920165"
                }
            }
        ]
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/aisp/accounts/87cb60fe-a16e-4189-a9da-949c187113ba/beneficiaries"
    },
    "Meta": {
        "TotalPages": 1
    }
}

5. Product – Specific Account

This API allows an AISP to retrieve the product details specific to an account.

The following optional field(s) is/are not populated by BOI for this API:

SecondaryProductId
ProductName
MarketingStateId
OtherProductType
BCA
PCA

GET request: Accounts Product

GET /accounts/87cb60fe-a16e-4189-a9da-949c187113ba/product HTTP/1.1

Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

GET response: Accounts Product

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
    "Data": {
        "Product": [
            {
                "ProductID": "PR12459856",
                "AccountId": "87cb60fe-a16e-4189-a9da-949c187113ba",
                "ProductType": "PersonalCurrentAccount"
            }
        ]
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/aisp/accounts/87cb60fe-a16e-4189-a9da-949c187113ba/product"
    },
    "Meta": {
        "TotalPages": 1
    }
}

6. Scheduled Payments – Specific Account

This API allows an AISP to retrieve the list of scheduled payments for a specific account.

The following optional field(s) is/are not populated by BOI for this API:

DebtorReference

GET request: Accounts Scheduled Payments

GET /accounts/87cb60fe-a16e-4189-a9da-949c187113ba/scheduled-payments HTTP/1.1

Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

GET response: Accounts Scheduled Payments

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
    "Data": {
        "ScheduledPayment": [
            {
                "AccountId": "87cb60fe-a16e-4189-a9da-949c187113ba",
                "ScheduledPaymentId": "SP23465318 ",
                "ScheduledPaymentDateTime": "2019-02-19T09:30:01+00:00",
                "ScheduledType": "Execution",
                "InstructedAmount": {
                    "Amount": "10.00",
                    "Currency": "EUR"
                },
                "CreditorAgent": {
                    "SchemeName": "UK.OBIE.BICFI",
                    "Identification": "BOFIIE2DXXX"
                },
                "CreditorAccount": {
                    "SchemeName": "UK.OBIE.IBAN",
                    "Identification": "IE40BOFI90123968920165"
                }
            }
        ]
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/aisp/accounts/87cb60fe-a16e-4189-a9da-949c187113ba/scheduled-payments"
    },
    "Meta": {
        "TotalPages": 1
    }
}

7. Standing Orders – Specific Account

This API allows an AISP to retrieve the list of standing orders that have been set up on a specific account.

The following optional field(s) is/are not populated by BOI for this API:

FirstPaymentDateTime
FirstPaymentAmount
FinalPaymentDateTime
FinalPaymentAmount
StandingOrderStatusCode
CreditorAgent
CreditorAccount.SecondaryIdentification
NumberofPayments
LastPaymentAmount
SupplementaryData

GET request: Accounts Standing Orders

GET /accounts/87cb60fe-a16e-4189-a9da-949c187113ba/standing-orders HTTP/1.1

Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

GET response: Accounts Standing Orders

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
    "Data": {
        "StandingOrder": [
            {
                "AccountId": "87cb60fe-a16e-4189-a9da-949c187113ba",
                "StandingOrderId": "SO57869670",
                "Frequency": "IntrvlWkDay:02:05",
                "Reference": "Daily Food",
                "NextPaymentDateTime": "2019-10-25T11:10:12.064Z",
                “LastPaymentDatetime”: "2019-10-11T11:10:12.064Z",
                "NextPaymentAmount": {
                    "Amount": "49.99",
                    "Currency": "EUR"
                },
                "CreditorAccount": {
                    "SchemeName": "UK.OBIE.IBAN",
                    "Identification": "IE40BOFIXXXXXXXX920165",
                }
            }
        ]
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/aisp/accounts/87cb60fe-a16e-4189-a9da-949c187113ba/standing-orders"
    },
    "Meta": {
        "TotalPages": 1
    }
}

8. Account Statement – List of statements for a specific account

This API allows an AISP to retrieve statement information of a single bank account identified by the unique AccountID.

The following optional field(s) is/are not populated by BOI for this API:

StatementDescription
StatementReference
StatementBenefit
StatementFee
StatementInterest
StatementAmount
StatementDateTime
StatementRate
StatementValue

GET request: Accounts Statements

GET /accounts/87cb60fe-a16e-4189-a9da-949c187113ba/statements HTTP/1.1

Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
Accept: application/json

GET response: Accounts Statements

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
    "Data": {
        "Statement": [
            {
                "AccountId": "87cb60fe-a16e-4189-a9da-949c187113ba",
                "StatementId": "2017113000301",
                "Type": "Annual",
                "StartDateTime": "2017-12-31T00:00:00+00:00",
                "EndDateTime": "2017-12-31T00:00:00+00:00",
                "CreationDateTime": "2017-12-31T00:00:00+00:00"
            }
        ]
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/aisp/accounts/87cb60fe-a16e-4189-a9da-949c187113ba/statements"
    },
    "Meta": {
        "TotalPages": 1
    }
}

9. Account Statement – File Download

This API allows an AISP to retrieve a file of a single statement identified by the unique AccountID and StatementID. The API will return unstructured data in PDF format which can be downloaded. This will be specified in the Accept header by the AISP. BOI currently supports only PDF format. BOI will provide a sample PDF statement when the Sandbox APIs are invoked through a tool.

GET request: Accounts Statements File

GET /accounts/87cb60fe-a16e-4189-a9da-949c187113ba/statements/2017113000301/file HTTP/1.1

Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/pdf
Accept: application/pdf

GET response: Accounts Statements File By StatementId

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/pdf

10. Single Account Transaction

This API allows an AISP to retrieve transaction information of a single bank account identified by the unique AccountID.

BOI provides the Proprietary Bank Transaction Code that defines the type of transaction. Description for the code can be viewed here.

The following optional field(s) is/are not populated by BOI for this API:

StatementReference
TransactionReference
TransactionMutability
ChargeAmount
CurrencyExchange
BankTransactionCode
ProprietaryBankTransactionCode.Issuer
DebtorAgent
DebtorAccount
CreditorAgent
CreditorAccount
CardInstrument
SupplementaryData

GET request: Accounts Transactions

GET /accounts/87cb60fe-a16e-4189-a9da-949c187113ba/transactions HTTP/1.1

Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

GET response: Accounts Transactions

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
    "Data": {
        "Transaction": [
            {
                "AccountId": "87cb60fe-a16e-4189-a9da-949c187113ba",
                "TransactionId": "TR90289333",
                "CreditDebitIndicator": "Credit",
                "Status": "Pending",
                "BookingDateTime": "2018-04-09T10:45:22+00:00",
                "ValueDateTime": "2018-07-20T07:29:09+00:00",
                "Amount": {
                    "Amount": "10.00",
                    "Currency": "EUR"
                },
                "ProprietaryBankTransactionCode": {
                    "Code": "030"
                },
                "TransactionInformation": "BONUS PAY",
                "Balance": {
                    "CreditDebitIndicator": "Credit",
                    "Type": "ClosingAvailable",
                    "Amount": {
                        "Amount": "230.00",
                        "Currency": "EUR"
                    }
                }
            }
        ]
    },
    "Links": {
        "Self": "https://api-sandbox.bankofireland.com/1/api/open-banking/v3.1.8/aisp/accounts/87cb60fe-a16e-4189-a9da-949c187113ba/transactions"
    },
    "Meta": {}
}

Versioning

This API specification conforms to the Open Banking UK Account and Transaction API Specification – v3.1.8

Account and Transaction Information Examples

1. Multiple account information

2. Single account information

3. Account Balance

4. Beneficiaries

5. Product – Specific Account

6. Scheduled Payments – Specific Account

7. Standing Orders – Specific Account

8. Account Statement – List of statements for a specific account

9. Account Statement – File Download

10. Single Account Transaction

Versioning

Reviews